Eclipse Platform
Pre-release 3.0

org.eclipse.ui.texteditor.quickdiff
Interface IQuickDiffReferenceProvider

All Known Subinterfaces:
IQuickDiffProviderImplementation

public interface IQuickDiffReferenceProvider

The protocol a reference provider for quickdiff has to implement. Quickdiff references provide a reference document (an IDocument) that is used as the original against which diff information is generated.

Extensions to the extension point quickdiff.referenceprovider have to implement this interface (plus another interface for plugin and UI management.

Since:
3.0
See Also:
IQuickDiffProviderImplementation

Method Summary
 void dispose()
          Called when the reference is no longer used and the provider can free resources.
 String getId()
          Returns the id of this reference provider.
 IDocument getReference(IProgressMonitor monitor)
          Returns the reference document for the quick diff display.
 

Method Detail

getReference

public IDocument getReference(IProgressMonitor monitor)
                       throws CoreException
Returns the reference document for the quick diff display.

Parameters:
monitor - a preference monitor to monitor / cancel the process, or null
Returns:
the reference document for the quick diff display or null if getting the document was canceled or there is no reference available.
Throws:
CoreException - if getting the document fails.

dispose

public void dispose()
Called when the reference is no longer used and the provider can free resources.


getId

public String getId()
Returns the id of this reference provider.

Returns:
the id of this provider as stated in the extending plugin's manifest.

Eclipse Platform
Pre-release 3.0

Copyright (c) IBM Corp. and others 2000, 2003. All Rights Reserved.